package org.wak.scene
{
	import org.wak.baseoneonline.flash.geom.IntPoint;
	
	public interface IActionSpotDefinition
	{
		/**
		 * the position of the gatespot on the scene 
		 * @return IntPoint containing the x and y coordinates.
		 * 
		 */		
		function get position():IntPoint ;
		
		/**
		 * Id of the action area. 
		 * @return String with the id.
		 * 
		 */		
		function get id():String
		
		/**
		 * Name of the action spot area 
		 * @return String with the name.
		 * 
		 */		
		function get name():String
		
		/**
		 * Description of the action spot area. 
		 * @return String with description.
		 * 
		 */		
		function get description():String
		
		/**
		 * Array of points to define the action spot shape. 
		 * @return Array of IntPoints.
		 * 
		 */		
		function get shape():Array ;
		
		/**
		 * Usually the player's character should walk to the item to interact
		 * with it. Well this is the point where the player will walk before
		 * interact with this item in some way. 
		 * @return IntPoint containing the coordinates of the interaction point.
		 * 
		 */		
		function get interactionPoint():IntPoint ;
		
		/**
		 * animation behaviour to set to the player's character display
		 * after walked to the interaction point. 
		 * @return 
		 * 
		 */		
		function get interactionBehaviour():String ;
		
		/**
		 * Action id as default 
		 * @return Action id as default for this object.
		 * 
		 */		
		function get defaultAction():String ;
		
		/**
		 * For debuging or setting the scene, the ActionSpot's area
		 * will be visible. 
		 * @return visibility flag.
		 * 
		 */		
		function get visible():Boolean ;
		
		function get enabled():Boolean ;
	}
}